Skip to content

SQL GA - Get started#571

Draft
kbatuigas wants to merge 7 commits into
rp-sqlfrom
DOC-1856-document-feature-sql-engine-deployment-in-cloud
Draft

SQL GA - Get started#571
kbatuigas wants to merge 7 commits into
rp-sqlfrom
DOC-1856-document-feature-sql-engine-deployment-in-cloud

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas commented May 2, 2026

Description

This pull request adds comprehensive "Get Started" documentation for Redpanda SQL, including new guides for enabling, connecting to, and using Redpanda SQL on BYOC clusters. The changes introduce a new navigation structure and detailed step-by-step instructions for both the Cloud Console and API workflows, as well as a hands-on quickstart for querying streaming data.

New Redpanda SQL onboarding documentation:

  • Added a new "Get Started" section for Redpanda SQL, including an overview index page (index.adoc), a quickstart guide for connecting and querying with psql (sql-quickstart.adoc), and a detailed guide for enabling, scaling, and disabling Redpanda SQL on BYOC clusters (deploy-sql-cluster.adoc). [1] [2] [3]

Navigation and structure updates:

  • Updated nav.adoc to include links to the new "Get Started," "Quickstart," and "Enable Redpanda SQL" guides under the Redpanda SQL section, improving discoverability and organization of onboarding content.

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

https://deploy-preview-571--rp-cloud.netlify.app/redpanda-cloud/sql/get-started/sql-quickstart/
https://deploy-preview-571--rp-cloud.netlify.app/redpanda-cloud/sql/get-started/deploy-sql-cluster/

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@netlify
Copy link
Copy Markdown

netlify Bot commented May 2, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit fb15751
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a04cbf3a06e3200081d2b7b
😎 Deploy Preview https://deploy-preview-571--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 2, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c776d8b5-123f-4d8c-9cf4-d40429c0c6a2

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-1856-document-feature-sql-engine-deployment-in-cloud

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Member

@andrewhsu andrewhsu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CREATE TABLE command needs to change to match web ui

Comment thread modules/sql/pages/get-started/sql-quickstart.adoc Outdated
@kbatuigas kbatuigas force-pushed the DOC-1856-document-feature-sql-engine-deployment-in-cloud branch from ae3ae40 to 2dd0c5a Compare May 11, 2026 23:03
kbatuigas and others added 7 commits May 13, 2026 12:07
Updates the Enable Redpanda SQL page so the horizontal-scaling range is
1 to 9 nodes (down from 1 to 12) per the PM SME 2026-05-07. Adds a TODO
on the Disable Redpanda SQL section listing the specific behaviors to
confirm with engineering before publication: what state is purged, what
is deleted from object storage, the effect on topic and Schema Registry
data, in-flight query error behavior, and re-enable semantics.

Updates the quickstart so it explicitly targets an admin who can view the
SQL connection details in the Cloud Console, and adds an optional
admin-run mini-section showing how to grant a non-admin user SELECT
access on a Redpanda SQL table. Includes a TODO referencing
qa-questions.md #21 to refine the role/grant example once engineering
confirms whether the SQL GRANT statement alone enforces per-user table
access or whether an additional ACL/Kafka-side step is required.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: Andrew Hsu <xuzuan@gmail.com>
@kbatuigas kbatuigas force-pushed the DOC-1856-document-feature-sql-engine-deployment-in-cloud branch from 2dd0c5a to fb15751 Compare May 13, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants